<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: SortingPropertyExtractor.html 947 2014-11-12 22:14:09Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>/**<a name="line.10"></a>
<span class="sourceLineNo">011</span> * {@link PropertyExtractor} that also sorts properties, given two instances of the target Java type.<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * @param &lt;T&gt; target object type for extraction<a name="line.13"></a>
<span class="sourceLineNo">014</span> */<a name="line.14"></a>
<span class="sourceLineNo">015</span>public interface SortingPropertyExtractor&lt;T&gt; extends PropertyExtractor&lt;T&gt; {<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>    /**<a name="line.17"></a>
<span class="sourceLineNo">018</span>     * Determine if the given property can be sorted by this instance.<a name="line.18"></a>
<span class="sourceLineNo">019</span>     * If this method returns false, then the property's sorting resorts to the default behavior,<a name="line.19"></a>
<span class="sourceLineNo">020</span>     * i.e., depending on whether the property value implements {@link Comparable}.<a name="line.20"></a>
<span class="sourceLineNo">021</span>     *<a name="line.21"></a>
<span class="sourceLineNo">022</span>     * @param propertyDef definition of property<a name="line.22"></a>
<span class="sourceLineNo">023</span>     * @return true if the property defined by {@code propertyDef} can be sorted by this instance<a name="line.23"></a>
<span class="sourceLineNo">024</span>     * @throws NullPointerException if {@code propertyDef} is null<a name="line.24"></a>
<span class="sourceLineNo">025</span>     */<a name="line.25"></a>
<span class="sourceLineNo">026</span>    boolean canSort(PropertyDef&lt;?&gt; propertyDef);<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>    /**<a name="line.28"></a>
<span class="sourceLineNo">029</span>     * Sort two values based on the given property.<a name="line.29"></a>
<span class="sourceLineNo">030</span>     *<a name="line.30"></a>
<span class="sourceLineNo">031</span>     * @param obj1 first Java object<a name="line.31"></a>
<span class="sourceLineNo">032</span>     * @param obj2 second Java object<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * @param propertyDef definition of property to sort on<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * @return result of comparing {@code obj1}'s property value to {@code obj2}'s property value<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * @throws NullPointerException if any parameter is null<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * @throws UnsupportedOperationException if the property defined by {@code propertyDef} cannot be sorted by this instance<a name="line.36"></a>
<span class="sourceLineNo">037</span>     */<a name="line.37"></a>
<span class="sourceLineNo">038</span>    int sort(PropertyDef&lt;?&gt; propertyDef, T obj1, T obj2);<a name="line.38"></a>
<span class="sourceLineNo">039</span>}<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>




























































</pre>
</div>
</body>
</html>
